
/****************************************************************************
** Copyright (c) 2006 - 2011, the LibQxt project.
** See the Qxt AUTHORS file for a list of authors and copyright holders.
** All rights reserved.
**
** Redistribution and use in source and binary forms, with or without
** modification, are permitted provided that the following conditions are met:
**     * Redistributions of source code must retain the above copyright
**       notice, this list of conditions and the following disclaimer.
**     * Redistributions in binary form must reproduce the above copyright
**       notice, this list of conditions and the following disclaimer in the
**       documentation and/or other materials provided with the distribution.
**     * Neither the name of the LibQxt project nor the
**       names of its contributors may be used to endorse or promote products
**       derived from this software without specific prior written permission.
**
** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
** ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
** WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
** DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
** DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
** (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
** LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
** ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
** SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
**
** <http://libqxt.org>  <foundation@libqxt.org>
*****************************************************************************/

#ifndef QXTSTRINGVALIDATOR_H_INCLUDED
#define QXTSTRINGVALIDATOR_H_INCLUDED

#include <QValidator>
#include <QStringList>
#include <QModelIndex>
#include "qxtglobal.h"

class QxtStringValidatorPrivate;
QT_FORWARD_DECLARE_CLASS(QAbstractItemModel)

class QXT_GUI_EXPORT QxtStringValidator : public QValidator
{
    Q_OBJECT

public:
    QxtStringValidator(QObject * parent);
    ~QxtStringValidator();

    virtual void fixup(QString & input) const;
    virtual QValidator::State validate(QString & input, int & pos) const;

    Qt::CaseSensitivity caseSensitivity() const;
    void setCaseSensitivity(Qt::CaseSensitivity caseSensitivity);
    void setStartModelIndex(const QModelIndex &index);
    void setStringList(const QStringList &stringList);
    void setRecursiveLookup(bool enable);
    void setWrappingLookup(bool enable);
    void setLookupModel(QAbstractItemModel *model);
    void setLookupRole(const int role);

    QModelIndex startModelIndex() const;
    bool recursiveLookup() const;
    bool wrappingLookup() const;
    QAbstractItemModel * lookupModel() const;
    int lookupRole() const;

private:
    QXT_DECLARE_PRIVATE(QxtStringValidator)
};

#endif //QXTSTRINGVALIDATOR_H_INCLUDED
